<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class LockCapabilities</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface LockCapabilities</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Allows discovery of locking support.</p>
<p class="description"><p>Level 2 only</p><p>Returned by <a href="../../phpContentRepository/Workspace.html#methodgetLockCapabilities">Workspace::getLockCapabilities()</a>. Provides information  about what locking features are supported by this implementation.</p></p>
	<ul class="tags">
				<li><span class="field">copyright:</span> Copyright &amp;copy; 2004-2005, Domain51</li>
				<li><span class="field">author:</span> PHP - Travis Swicegood &lt;<a href="mailto:travis@domain51.net">travis@domain51.net</a>&gt;</li>
				<li><span class="field">see:</span> <a href="../../phpContentRepository/Workspace.html#methodgetLockCapabilities">Workspace::getLockCapabilities()</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_lock_LockCapabilities_interface_php.html">/lock/LockCapabilities.interface.php</a> (line <span class="field">42</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
								
				<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#getSupportedLockTypes" title="details" class="method-name">getSupportedLockTypes</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#isExclusiveLockSupported" title="details" class="method-name">isExclusiveLockSupported</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#isPropertyLockSupported" title="details" class="method-name">isPropertyLockSupported</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#isSharedLockSupported" title="details" class="method-name">isSharedLockSupported</a>
										()
									</div>
							</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodgetSupportedLockTypes" id="getSupportedLockTypes"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getSupportedLockTypes</span> (line <span class="line-number">84</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Reports the supported lock types. If locking is supported at all, this  will include at least <a href="../../phpContentRepository/Level2/LockType.html#constWRITE_LOCK">LockType::WRITE_LOCK</a>. If other lock types  are also supported then these are returned as well.</p>
	<ul class="tags">
				<li><span class="field">return:</span> An array of <a href="../../phpContentRepository/Level2/LockType.html">LockType</a> objects representing all supported lock    types.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			getSupportedLockTypes
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodisExclusiveLockSupported" id="isExclusiveLockSupported"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">isExclusiveLockSupported</span> (line <span class="line-number">51</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Reports whether exclusive locks are supported by this implementation.</p>
	<ul class="tags">
				<li><span class="field">return:</span> TRUE if exclusive locks are supported; FALSE    otherwise.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			isExclusiveLockSupported
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodisPropertyLockSupported" id="isPropertyLockSupported"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">isPropertyLockSupported</span> (line <span class="line-number">72</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Reports whether locking at the the level of individual properties is  supported by this implementation.</p>
	<ul class="tags">
				<li><span class="field">return:</span> TRUE if property locking is supported; FALSE    otherwise.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			isPropertyLockSupported
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodisSharedLockSupported" id="isSharedLockSupported"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">isSharedLockSupported</span> (line <span class="line-number">61</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Reports whether shared locks are supported by this implementation.</p>
	<ul class="tags">
				<li><span class="field">return:</span> TRUE if shared locks are supported; FALSE    otherwise.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			isSharedLockSupported
		</span>
				()
			</div>
	
		
		
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 31 Dec 2004 10:15:13 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</p>
	</div></body>
</html>